Skip to main content

Payment Link

The Paylode payment link feature enables merchants to generate a payment link and share it with customers for quick online payments.

POST   https://pgmerchantsapi.paylodeservices.com/api/v1/invoice

Request Sample​

The code snippet below shows an example request for creating a payment link

curl
curl -X 'POST' \
  'https://pgmerchantsapi.paylodeservices.com/api/v1/invoice' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer eyJhbGci***************' \
  -H 'Content-Type: application/json' \
  -d '{
  "currencyCode": "NGN",
  "linkUsageType": "Single",
  "expiryDate": "2024-04-13",
  "customerEmail": "[email protected]",
  "customerPhoneNumber": "090000000",
  "description": "payment for bags",
  "amount": 2000,
  "customerToEditEmail": true,
  "customerToEditAmount": true
}'

Response Sample​

The code snippet below shows an example response for creating a payment link

{
  "data": {
    "amount": 2000,
    "sessionReference": "052a41602ac54119bb1a515016350620",
    "currencyCode": "NGN",
    "description": "payment for bags",
    "merchantId": "088d8aeca5084********19eaf17a727",
    "expiration": "2024-04-13T00:00:00",
    "paymentLink": "https://www.paylodeservices.com/pay?session=PAYL_MDUyYTQxNjAyYWM1NDExOWJiMWE1MTUwM********",
    "linkUsageType": "Single",
    "customerEmail": "[email protected]",
    "invoiceId": null,
    "reference": "052a41602ac5********515016350620",
    "customerToEditEmail": true,
    "customerToEditAmount": true
  },
  "isSuccessful": true,
  "message": "Request was Successful",
  "responseCode": "00",
  "errors": []
}

GET   https://pgmerchantsapi.paylodeservices.com/api/v1/invoice

Request Sample​

The code snippet below shows an example request for getting a payment link

curl
curl -X 'GET' \
  'https://pgmerchantsapi.paylodeservices.com/api/v1/invoice/list?PageIndex=1&PageSize=20' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1******'\

Response Sample​

The code snippet below shows an example response for getting the list of payment link of a merchant.

{
  "data": {
    "results": [
      {
        "amount": 2000,
        "sessionReference": "052a41602ac54119bb1a515016350620",
        "currencyCode": "NGN",
        "description": "payment for bags",
        "merchantId": "088d8aeca508*****6619eaf17a727",
        "expiration": "2024-04-13T00:00:00",
        "paymentLink": "https://www.paylodeservices.com/pay?session=PAYL_MDUyYTQxNjAyYWM1NDExOWJiMWE1******",
        "linkUsageType": "Single",
        "customerEmail": "[email protected]",
        "invoiceId": null,
        "reference": "052a41602ac5******1a515016350620",
        "customerToEditEmail": true,
        "customerToEditAmount": true
      },
      {
        "amount": 200,
        "sessionReference": "c2f9611e94dc43b28604296944df94fa",
        "currencyCode": "NGN",
        "description": "payment for bags",
        "merchantId": "088d8aeca5084acbbe86619eaf17a727",
        "expiration": "2024-04-13T00:00:00",
        "paymentLink": "https://www.paylodeservices.com/pay?session=PAYL_YzJmOTYxMWU5NGRjNDNiMjg2MDQyOTY5NDRkZjk0ZmE=",
        "linkUsageType": "Single",
        "customerEmail": "[email protected]",
        "invoiceId": null,
        "reference": "c2f9611e94dc43b28604296944df94fa",
        "customerToEditEmail": true,
        "customerToEditAmount": true
      },

          ],
    "currentPage": 1,
    "pageCount": 1,
    "pageSize": 20,
    "rowCount": 2,
    "firstRowOnPage": 1,
    "lastRowOnPage": 20
  },
  "isSuccessful": true,
  "message": "Request was Successful",
  "responseCode": "00",
  "errors": []
}

💬 We're here to help!​

With Paylode, you can bring your fintech concepts to life swiftly. should you encounter any challenges, dont hesitate to reach out to us via email